LD-SDA Documentation #3539
Merged
LD-SDA Documentation #3539
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…iefly in GDPopt documentation
…input for the LDSDA.
…ction definitions.
emma58
requested changes
Mar 25, 2025
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3539 +/- ##
=======================================
Coverage 88.70% 88.70%
=======================================
Files 888 888
Lines 102024 102024
=======================================
Hits 90505 90505
Misses 11519 11519
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
emma58
approved these changes
Apr 1, 2025
blnicho
requested changes
Apr 1, 2025
…/pyomo into ldsda_documentation
blnicho
approved these changes
Apr 2, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary/Motivation:
This PR enhances the Pyomo Documentation by incorporating detailed instructions on utilizing the Logic-based Discrete-Steepest Descent Algorithm (LD-SDA) solver within the Generalized Disjunctive Programming optimizer (GDPopt).
It includes additional narrative content and a usage example and ensures that the LD-SDA solver class is included in the API documentation.
Changes proposed in this PR:
starting_point,logical_constraint_list, anddirection_norm.~pyomo.contrib.gdpopt.ldsda.GDP_LDSDA_Solverto the autodoc list to enable API documentation rendering.The narrative content and example were added at the bottom of
gdpopt.rst.The autodoc entry for
GDP_LDSDA_Solverwas appended to the list of GDPopt solver classes to ensure it appears in the API reference.Legal Acknowledgement
By contributing to this software project, I have read the contribution guide and agree to the following terms and conditions for my contribution: